Health Protection Electronic Notification (HPEN)
Domain Message Specification

EmployerOrEducationalContact Tabular View

COCD_TP146032GB01
EmployerOrEducationalContact

This template class constrains the CDA Observation class.

This class is the root class to the employer or educational establishment contact details.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance
  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }
Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance
  • The XML attribute moodCode is fixed to "EVN"
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="EMPLD" }
Model Attribute Description

The HL7 attribute code uses a code from a vocabulary to identify the observation type.

Implementation in XML Instance

When using this template then:

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
  • The XML attribute code is fixed to "EMPLD"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall contain "Employment Details"
[1..1] [M] id (II)
Model Attribute Description

The HL7 attribute id uses an identifier to identify each unique instance of a section.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:
  • The XML attribute root shall contain a DCE UUID
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146032GB01#EmployerOrEducationalContact" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146032GB01#EmployerOrEducationalContact"
[1..1] [M] participant
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="DIR" }
Model Attribute Description

The HL7 attribute typeCode describes this class as a direct target participation.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "DIR".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd in the actRelationships is set to " true".

The value of this attribute is fixed in the HL7 model to " OP":
  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".
Implementation in XML Instance
  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146032GB01#participant" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146032GB01#participant"
[1..1] [M] participantRole (ParticipantRole)
A link to the employer or educational establishment contact details
ParticipantRole

This template class constrains the CDA participantRole class.

This class is a link to the visited overseas country code and name

Used by: EmployerOrEducationalContact
[1..1] [M] classCode (CS { CNE: RoleClass } )
{ Fixed="ROL" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a role.

Implementation in XML Instance
  • The XML attribute classCode is fixed to "ROL".
[0..1] addr (AD)

Model Attribute Description

The HL7 attribute addr is used to hold the address of the place of employment or education establishment the patient attends.

The HL7 attribute addr allows structured and unstructured addresses to be carried. Only structured addresses are recommended to be used.

Implementation in XML Instance

The XML element addr is populated as follows:

  • The XML attribute use of the XML element addr shall be fixed to "WP"
  • The first XML element streetAddressLine shall contain the organisation name
  • The up to 4 more XML streetAddressLine elements shall contain the rest of the address
  • The XML element postalCode can be used to carry a postcode
[0..1] telecom (TEL)

Model Attribute Description

The HL7 Attribute telecom is used to hold the telephone number of employment or education establishment the patient attends..

Implementation in XML Instance

The XML value attribute of the XML element telecom should contain the telephone prefixed by "tel:"

The XML use attribute of the XML element telecom is fixed to "WP"

[1..1] [M] templateId (II)
{ Fixed="COCD_TP146032GB01#participantRole" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146032GB01#participantRole"